﻿#region License

// Another free, open solution by someone who gets it.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

#endregion

using System;
using System.Collections.Generic;
using System.Linq;

namespace Patterns.Validation.Formatting
{
	/// <summary>
	/// 	Provides services for formatting an object being used in an assertion in a human readable format.
	/// </summary>
	public static class Formatter
	{
		/// <summary>
		/// 	A list of objects responsible for formatting the objects represented by placeholders.
		/// </summary>
		private static readonly List<IValueFormatter> _formatters = new List<IValueFormatter>
		{
			new NullValueFormatter(),
			new DateTimeValueFormatter(),
			new TimeSpanValueFormatter(),
			new NumericValueFormatter(),
			new StringValueFormatter(),
			new ExpressionValueFormatter(),
			new EnumerableValueFormatter(),
			new DefaultValueFormatter()
		};

		/// <summary>
		/// 	Returns a human-readable representation of a particular object.
		/// </summary>
		/// <param name = "value">The value for which to create a <see cref = "System.String" />.</param>
		/// <param name = "nestedPropertyLevel">
		/// 	The level of nesting for the supplied value. This is used for indenting the format string for objects that have
		/// 	no <see cref = "object.ToString()" /> override.
		/// </param>
		/// <returns>
		/// 	A <see cref = "System.String" /> that represents this instance.
		/// </returns>
		public static string ToString(object value, int nestedPropertyLevel = 0)
		{
			IValueFormatter firstFormatterThatCanHandleValue = _formatters.First(f => f.CanHandle(value));

			return firstFormatterThatCanHandleValue.ToString(value, nestedPropertyLevel);
		}

		/// <summary>
		/// 	Returns a human-readable representation of a particular object that starts on a new line.
		/// </summary>
		/// <param name = "value">The value for which to create a <see cref = "System.String" />.</param>
		/// <param name = "nestedPropertyLevel">
		/// 	The level of nesting for the supplied value. This is used for indenting the format string for objects that have
		/// 	no <see cref = "object.ToString()" /> override.
		/// </param>
		/// <returns>
		/// 	A <see cref = "System.String" /> that represents this instance.
		/// </returns>
		public static string ToStringLine(object value, int nestedPropertyLevel = 0)
		{
			return Environment.NewLine + ToString(value, nestedPropertyLevel);
		}
	}
}